NavChooseVolume

NavChooseVolume
Header:	Navigation.h		Carbon status:	Supported

Displays a dialog box that prompts the user to choose a volume.

OSErr NavChooseVolume (
    AEDesc *defaultSelection, 
    NavReplyRecord *reply, 
    NavDialogOptions *dialogOptions, 
    NavEventUPP eventProc, 
    NavObjectFilterUPP filterProc, 
    void *callBackUD
);

Parameter descriptions

defaultSelection: A pointer to an Apple event descriptor structure (AEDesc). Before calling NavChooseVolume, you can set up a structure of AEDesc type 'typeFSS' to specify a default location to be viewed. If you pass NULL in this parameter, Navigation Services displays the last location visited during a call to the NavChooseVolume function. If the file system specification in the AEDesc structure does not describe a directory or volume, Navigation Services uses the desktop as the default location.
reply: A pointer to a structure of type NavReplyRecord. Upon return, Navigation Services uses this structure to provide data to your application about the results of your NavChooseVolume call.
dialogOptions: A pointer to a structure of type NavDialogOptions. Before calling, set up this structure to specify dialog box settings. If you pass NULL in this parameter, Navigation Services uses the defaults for all options. See “Dialog Option Configuration Constants” for a description of the default settings.
eventProc: A Universal Procedure Pointer (UPP) of type NavEventProcPtr that points to your application-defined event-handling function. You obtain this UPP by calling the macro NewNavEventProc. Implementing an event-handling function allows your application to update windows after the user moves or resizes the dialog box. If you pass NULL in this parameter, the Choose a Volume dialog box is not movable or resizable. For more information, see “Handling Events”.
filterProc: A Universal Procedure Pointer (UPP) of type NavObjectFilterProcPtr that points to your application-defined filter function. Obtain this UPP by calling the macro NewNavObjectFilterProc. An application-defined filter function determines if a volume, directory, or file should be displayed in the browser list or pop-up menus. For more information, see “Filtering File Objects”.
callBackUD: A pointer to a value set by your application. When the NavChooseVolume function calls your event-handling function, the callBackUD value is passed back to your application.

function result: A result code.

DISCUSSION

This function provides a way for your application to prompt the user to select a volume. This might be useful for a disk repair utility, for example.

VERSION NOTES

Available in Navigation Services 1.0 and later.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.